home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / pyshared / pyatspi / registry.py < prev    next >
Text File  |  2009-10-19  |  29KB  |  811 lines

  1. '''
  2. Registry that hides some of the details of registering for AT-SPI events and
  3. starting and stopping the main program loop.
  4.  
  5. @todo: PP: when to destroy device listener?
  6.  
  7. @author: Peter Parente
  8. @organization: IBM Corporation
  9. @copyright: Copyright (c) 2005, 2007 IBM Corporation
  10. @license: LGPL
  11.  
  12. This library is free software; you can redistribute it and/or
  13. modify it under the terms of the GNU Library General Public
  14. License as published by the Free Software Foundation; either
  15. version 2 of the License, or (at your option) any later version.
  16.  
  17. This library is distributed in the hope that it will be useful,
  18. but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20. Library General Public License for more details.
  21.  
  22. You should have received a copy of the GNU Library General Public
  23. License along with this library; if not, write to the
  24. Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  25. Boston, MA 02111-1307, USA.
  26.  
  27. Portions of this code originally licensed and copyright (c) 2005, 2007
  28. IBM Corporation under the BSD license, available at
  29. U{http://www.opensource.org/licenses/bsd-license.php}
  30. '''
  31. import signal
  32. import time
  33. import weakref
  34. import Queue
  35. import traceback
  36. import ORBit
  37. import bonobo
  38. import gobject
  39. import Accessibility
  40. import Accessibility__POA
  41. import utils
  42. import constants
  43. import event
  44.  
  45. class _Observer(object):
  46.   '''
  47.   Parent class for all event observers. Dispatches all received events to the 
  48.   L{Registry} that created this L{_Observer}. Provides basic reference counting
  49.   functionality needed by L{Registry} to determine when an L{_Observer} can be
  50.   released for garbage collection. 
  51.   
  52.   The reference counting provided by this class is independent of the reference
  53.   counting used by CORBA. Keeping the counts separate makes it easier for the
  54.   L{Registry} to detect when an L{_Observer} can be freed in the 
  55.   L{Registry._unregisterObserver} method.
  56.   
  57.   @ivar registry: Reference to the L{Registry} that created this L{_Observer}
  58.   @type registry: weakref.proxy to L{Registry}
  59.   @ivar ref_count: Reference count on this L{_Observer}
  60.   @type ref_count: integer
  61.   '''
  62.   def __init__(self, registry):
  63.     '''
  64.     Stores a reference to the creating L{Registry}. Intializes the reference
  65.     count on this object to zero.
  66.     
  67.     @param registry: The L{Registry} that created this observer
  68.     @type registry: weakref.proxy to L{Registry}
  69.     '''
  70.     self.registry = weakref.proxy(registry)
  71.     self.ref_count = 0
  72.  
  73.   def clientRef(self):
  74.     '''
  75.     Increments the Python reference count on this L{_Observer} by one. This
  76.     method is called when a new client is registered in L{Registry} to receive
  77.     notification of an event type monitored by this L{_Observer}.
  78.     '''
  79.     self.ref_count += 1
  80.     
  81.   def clientUnref(self):
  82.     '''    
  83.     Decrements the pyatspi reference count on this L{_Observer} by one. This
  84.     method is called when a client is unregistered in L{Registry} to stop
  85.     receiving notifications of an event type monitored by this L{_Observer}.
  86.     '''
  87.     self.ref_count -= 1
  88.     
  89.   def getClientRefCount(self):
  90.     '''
  91.     @return: Current Python reference count on this L{_Observer}
  92.     @rtype: integer
  93.     '''
  94.     return self.ref_count
  95.   
  96.   def ref(self): 
  97.     '''Required by CORBA. Does nothing.'''
  98.     pass
  99.     
  100.   def unref(self): 
  101.     '''Required by CORBA. Does nothing.'''
  102.     pass
  103.  
  104. class _DeviceObserver(_Observer, Accessibility__POA.DeviceEventListener):
  105.   '''
  106.   Observes keyboard press and release events.
  107.   
  108.   @ivar registry: The L{Registry} that created this observer
  109.   @type registry: L{Registry}
  110.   @ivar key_set: Set of keys to monitor
  111.   @type key_set: list of integer
  112.   @ivar mask: Watch for key events while these modifiers are held
  113.   @type mask: integer
  114.   @ivar kind: Kind of events to monitor
  115.   @type kind: integer
  116.   @ivar mode: Keyboard event mode
  117.   @type mode: Accessibility.EventListenerMode
  118.   '''
  119.   def __init__(self, registry, synchronous, preemptive, global_):
  120.     '''
  121.     Creates a mode object that defines when key events will be received from 
  122.     the system. Stores all other information for later registration.
  123.     
  124.     @param registry: The L{Registry} that created this observer
  125.     @type registry: L{Registry}
  126.     @param synchronous: Handle the key event synchronously?
  127.     @type synchronous: boolean
  128.     @param preemptive: Allow event to be consumed?
  129.     @type preemptive: boolean
  130.     @param global_: Watch for events on inaccessible applications too?
  131.     @type global_: boolean
  132.     '''
  133.     _Observer.__init__(self, registry)   
  134.     self.mode = Accessibility.EventListenerMode()
  135.     self.mode.preemptive = preemptive
  136.     self.mode.synchronous = synchronous
  137.     self.mode._global = global_    
  138.    
  139.   def register(self, dc, key_set, mask, kind):
  140.     '''
  141.     Starts keyboard event monitoring.
  142.     
  143.     @param dc: Reference to a device controller
  144.     @type dc: Accessibility.DeviceEventController
  145.     @param key_set: Set of keys to monitor
  146.     @type key_set: list of integer
  147.     @param mask: Integer modifier mask or an iterable over multiple masks to
  148.       unapply all at once
  149.     @type mask: integer, iterable, or None
  150.     @param kind: Kind of events to monitor
  151.     @type kind: integer
  152.     '''
  153.     try:
  154.       # check if the mask is iterable
  155.       iter(mask)
  156.     except TypeError:
  157.       # register a single integer if not
  158.       dc.registerKeystrokeListener(self._this(), key_set, mask, kind, 
  159.                                    self.mode)
  160.     else:
  161.       for m in mask:
  162.         dc.registerKeystrokeListener(self._this(), key_set, m, kind, self.mode)
  163.  
  164.   def unregister(self, dc, key_set, mask, kind):
  165.     '''
  166.     Stops keyboard event monitoring.
  167.     
  168.     @param dc: Reference to a device controller
  169.     @type dc: Accessibility.DeviceEventController
  170.     @param key_set: Set of keys to monitor
  171.     @type key_set: list of integer
  172.     @param mask: Integer modifier mask or an iterable over multiple masks to
  173.       unapply all at once
  174.     @type mask: integer, iterable, or None
  175.     @param kind: Kind of events to monitor
  176.     @type kind: integer
  177.     '''
  178.     try:
  179.       # check if the mask is iterable
  180.       iter(mask)
  181.     except TypeError:
  182.       # unregister a single integer if not
  183.       dc.deregisterKeystrokeListener(self._this(), key_set, mask, kind)
  184.     else:
  185.       for m in mask:
  186.         dc.deregisterKeystrokeListener(self._this(), key_set, m, kind)
  187.       
  188.   def queryInterface(self, repo_id):
  189.     '''
  190.     Reports that this class only implements the AT-SPI DeviceEventListener 
  191.     interface. Required by AT-SPI.
  192.     
  193.     @param repo_id: Request for an interface 
  194.     @type repo_id: string
  195.     @return: The underlying CORBA object for the device event listener
  196.     @rtype: Accessibility.EventListener
  197.     '''
  198.     if repo_id == utils.getInterfaceIID(Accessibility.DeviceEventListener):
  199.       return self._this()
  200.     else:
  201.       return None
  202.  
  203.   def notifyEvent(self, ev):
  204.     '''
  205.     Notifies the L{Registry} that an event has occurred. Wraps the raw event 
  206.     object in our L{Event} class to support automatic ref and unref calls. An
  207.     observer can return True to indicate this event should not be allowed to pass 
  208.     to other AT-SPI observers or the underlying application.
  209.     
  210.     @param ev: Keyboard event
  211.     @type ev: Accessibility.DeviceEvent
  212.     @return: Should the event be consumed (True) or allowed to pass on to other
  213.       AT-SPI observers (False)?
  214.     @rtype: boolean
  215.     '''
  216.     # wrap the device event
  217.     ev = event.DeviceEvent(ev)
  218.     return self.registry.handleDeviceEvent(ev, self)
  219.  
  220. class _EventObserver(_Observer, Accessibility__POA.EventListener):
  221.   '''
  222.   Observes all non-keyboard AT-SPI events. Can be reused across event types.
  223.   '''
  224.   def register(self, reg, name):
  225.     '''
  226.     Starts monitoring for the given event.
  227.     
  228.     @param name: Name of the event to start monitoring
  229.     @type name: string
  230.     @param reg: Reference to the raw registry object
  231.     @type reg: Accessibility.Registry
  232.     '''
  233.     reg.registerGlobalEventListener(self._this(), name)
  234.     
  235.   def unregister(self, reg, name):
  236.     '''
  237.     Stops monitoring for the given event.
  238.     
  239.     @param name: Name of the event to stop monitoring
  240.     @type name: string
  241.     @param reg: Reference to the raw registry object
  242.     @type reg: Accessibility.Registry
  243.     '''
  244.     reg.deregisterGlobalEventListener(self._this(), name)
  245.  
  246.   def queryInterface(self, repo_id):
  247.     '''
  248.     Reports that this class only implements the AT-SPI DeviceEventListener 
  249.     interface. Required by AT-SPI.
  250.  
  251.     @param repo_id: Request for an interface 
  252.     @type repo_id: string
  253.     @return: The underlying CORBA object for the device event listener
  254.     @rtype: Accessibility.EventListener
  255.     '''
  256.     if repo_id == utils.getInterfaceIID(Accessibility.EventListener):
  257.       return self._this()
  258.     else:
  259.       return None
  260.  
  261.   def notifyEvent(self, ev):
  262.     '''
  263.     Notifies the L{Registry} that an event has occurred. Wraps the raw event 
  264.     object in our L{Event} class to support automatic ref and unref calls.
  265.     Aborts on any exception indicating the event could not be wrapped.
  266.     
  267.     @param ev: AT-SPI event signal (anything but keyboard)
  268.     @type ev: Accessibility.Event
  269.     '''
  270.     # wrap raw event so ref counts are correct before queueing
  271.     ev = event.Event(ev)
  272.     self.registry.handleEvent(ev)
  273.  
  274. class Registry(object):
  275.   '''
  276.   Wraps the Accessibility.Registry to provide more Pythonic registration for
  277.   events. 
  278.   
  279.   This object should be treated as a singleton, but such treatment is not
  280.   enforced. You can construct another instance of this object and give it a
  281.   reference to the Accessibility.Registry singleton. Doing so is harmless and
  282.   has no point.
  283.   
  284.   @ivar async: Should event dispatch to local listeners be decoupled from event
  285.     receiving from the registry?
  286.   @type async: boolean
  287.   @ivar reg: Reference to the real, wrapped registry object
  288.   @type reg: Accessibility.Registry
  289.   @ivar dev: Reference to the device controller
  290.   @type dev: Accessibility.DeviceEventController
  291.   @ivar queue: Queue of events awaiting local dispatch
  292.   @type queue: Queue.Queue
  293.   @ivar clients: Map of event names to client listeners
  294.   @type clients: dictionary
  295.   @ivar observers: Map of event names to AT-SPI L{_Observer} objects
  296.   @type observers: dictionary
  297.   '''
  298.   def __init__(self, reg):
  299.     '''
  300.     Stores a reference to the AT-SPI registry. Gets and stores a reference
  301.     to the DeviceEventController.
  302.     
  303.     @param reg: Reference to the AT-SPI registry daemon
  304.     @type reg: Accessibility.Registry
  305.     '''
  306.     self.reg = reg
  307.     self.async = None
  308.     self.queue = Queue.Queue()
  309.     self.clients = {}
  310.     self.observers = {}
  311.  
  312.     if self.reg is not None:
  313.       self.dev = self.reg.getDeviceEventController()
  314.     else:
  315.       self.dev = None
  316.  
  317.   def __call__(self, reg=None):
  318.     '''
  319.     @return: This instance of the registry. If we are passed a remote registry
  320.     instance for the first time, add it to our instance, and get a device event
  321.     controller.
  322.     @rtype: L{Registry}
  323.     '''
  324.     if reg and not self.reg:
  325.       self.reg = reg
  326.       self.dev = self.reg.getDeviceEventController()
  327.     return self
  328.   
  329.   def __getattribute__(self, attr):
  330.     if attr != 'reg' and object.__getattribute__(self, 'reg') is None:
  331.       raise RuntimeError('Could not find or activate registry')
  332.     else:
  333.       return object.__getattribute__(self, attr)
  334.  
  335.   def start(self, async=False, gil=True):
  336.     '''
  337.     Enter the main loop to start receiving and dispatching events.
  338.     
  339.     @param async: Should event dispatch be asynchronous (decoupled) from 
  340.       event receiving from the AT-SPI registry?
  341.     @type async: boolean
  342.     @param gil: Add an idle callback which releases the Python GIL for a few
  343.       milliseconds to allow other threads to run? Necessary if other threads
  344.       will be used in this process.
  345.     @type gil: boolean
  346.     '''
  347.     self.async = async
  348.     
  349.     if gil:
  350.       def releaseGIL():
  351.         try:
  352.           time.sleep(1e-5)
  353.         except KeyboardInterrupt, e:
  354.           # store the exception for later
  355.           releaseGIL.keyboard_exception = e
  356.           self.stop()
  357.         return True
  358.       # make room for an exception if one occurs during the 
  359.       releaseGIL.keyboard_exception = None
  360.       i = gobject.idle_add(releaseGIL)
  361.       
  362.     # enter the main loop
  363.     try:
  364.       bonobo.main()
  365.     finally:
  366.       # clear all observers
  367.       for name, ob in self.observers.items():
  368.         ob.unregister(self.reg, name)
  369.       if gil:
  370.         gobject.source_remove(i)
  371.         if releaseGIL.keyboard_exception is not None:
  372.           # raise an keyboard exception we may have gotten earlier
  373.           raise releaseGIL.keyboard_exception
  374.  
  375.   def stop(self, *args):
  376.     '''Quits the main loop.'''
  377.     try:
  378.       bonobo.main_quit()
  379.     except RuntimeError:
  380.       # ignore errors when quitting (probably already quitting)
  381.       pass
  382.     self.flushEvents()
  383.     
  384.   def getDesktopCount(self):
  385.     '''
  386.     Gets the number of available desktops.
  387.     
  388.     @return: Number of desktops
  389.     @rtype: integer
  390.     @raise LookupError: When the count cannot be retrieved
  391.     '''
  392.     try:
  393.       return self.reg.getDesktopCount()
  394.     except Exception:
  395.       raise LookupError
  396.     
  397.   def getDesktop(self, i):
  398.     '''
  399.     Gets a reference to the i-th desktop.
  400.     
  401.     @param i: Which desktop to get
  402.     @type i: integer
  403.     @return: Desktop reference
  404.     @rtype: Accessibility.Desktop
  405.     @raise LookupError: When the i-th desktop cannot be retrieved
  406.     '''
  407.     try:
  408.       return self.reg.getDesktop(i)
  409.     except Exception, e:
  410.       raise LookupError(e)
  411.     
  412.   def registerEventListener(self, client, *names):
  413.     '''
  414.     Registers a new client callback for the given event names. Supports 
  415.     registration for all subevents if only partial event name is specified.
  416.     Do not include a trailing colon.
  417.     
  418.     For example, 'object' will register for all object events, 
  419.     'object:property-change' will register for all property change events,
  420.     and 'object:property-change:accessible-parent' will register only for the
  421.     parent property change event.
  422.     
  423.     Registered clients will not be automatically removed when the client dies.
  424.     To ensure the client is properly garbage collected, call 
  425.     L{deregisterEventListener}.
  426.  
  427.     @param client: Callable to be invoked when the event occurs
  428.     @type client: callable
  429.     @param names: List of full or partial event names
  430.     @type names: list of string
  431.     '''
  432.     for name in names:
  433.       # store the callback for each specific event name
  434.       self._registerClients(client, name)
  435.  
  436.   def deregisterEventListener(self, client, *names):
  437.     '''
  438.     Unregisters an existing client callback for the given event names. Supports 
  439.     unregistration for all subevents if only partial event name is specified.
  440.     Do not include a trailing colon.
  441.     
  442.     This method must be called to ensure a client registered by
  443.     L{registerEventListener} is properly garbage collected.
  444.  
  445.     @param client: Client callback to remove
  446.     @type client: callable
  447.     @param names: List of full or partial event names
  448.     @type names: list of string
  449.     @return: Were event names specified for which the given client was not
  450.       registered?
  451.     @rtype: boolean
  452.     '''
  453.     missed = False
  454.     for name in names:
  455.       # remove the callback for each specific event name
  456.       missed |= self._unregisterClients(client, name)
  457.     return missed
  458.  
  459.   def registerKeystrokeListener(self, client, key_set=[], mask=0, 
  460.                                 kind=(constants.KEY_PRESSED_EVENT, 
  461.                                       constants.KEY_RELEASED_EVENT),
  462.                                 synchronous=True, preemptive=True, 
  463.                                 global_=False):
  464.     '''
  465.     Registers a listener for key stroke events.
  466.     
  467.     @param client: Callable to be invoked when the event occurs
  468.     @type client: callable
  469.     @param key_set: Set of hardware key codes to stop monitoring. Leave empty
  470.       to indicate all keys.
  471.     @type key_set: list of integer
  472.     @param mask: When the mask is None, the codes in the key_set will be 
  473.       monitored only when no modifier is held. When the mask is an 
  474.       integer, keys in the key_set will be monitored only when the modifiers in
  475.       the mask are held. When the mask is an iterable over more than one 
  476.       integer, keys in the key_set will be monitored when any of the modifier
  477.       combinations in the set are held.
  478.     @type mask: integer, iterable, None
  479.     @param kind: Kind of events to watch, KEY_PRESSED_EVENT or 
  480.       KEY_RELEASED_EVENT.
  481.     @type kind: list
  482.     @param synchronous: Should the callback notification be synchronous, giving
  483.       the client the chance to consume the event?
  484.     @type synchronous: boolean
  485.     @param preemptive: Should the callback be allowed to preempt / consume the
  486.       event?
  487.     @type preemptive: boolean
  488.     @param global_: Should callback occur even if an application not supporting
  489.       AT-SPI is in the foreground? (requires xevie)
  490.     @type global_: boolean
  491.     '''
  492.     try:
  493.       # see if we already have an observer for this client
  494.       ob = self.clients[client]
  495.     except KeyError:
  496.       # create a new device observer for this client
  497.       ob = _DeviceObserver(self, synchronous, preemptive, global_)
  498.       # store the observer to client mapping, and the inverse
  499.       self.clients[ob] = client
  500.       self.clients[client] = ob
  501.     if mask is None:
  502.       # None means all modifier combinations
  503.       mask = utils.allModifiers()
  504.     # register for new keystrokes on the observer
  505.     ob.register(self.dev, key_set, mask, kind)
  506.  
  507.   def deregisterKeystrokeListener(self, client, key_set=[], mask=0, 
  508.                                   kind=(constants.KEY_PRESSED_EVENT, 
  509.                                         constants.KEY_RELEASED_EVENT)):
  510.     '''
  511.     Deregisters a listener for key stroke events.
  512.     
  513.     @param client: Callable to be invoked when the event occurs
  514.     @type client: callable
  515.     @param key_set: Set of hardware key codes to stop monitoring. Leave empty
  516.       to indicate all keys.
  517.     @type key_set: list of integer
  518.     @param mask: When the mask is None, the codes in the key_set will be 
  519.       monitored only when no modifier is held. When the mask is an 
  520.       integer, keys in the key_set will be monitored only when the modifiers in
  521.       the mask are held. When the mask is an iterable over more than one 
  522.       integer, keys in the key_set will be monitored when any of the modifier
  523.       combinations in the set are held.
  524.     @type mask: integer, iterable, None
  525.     @param kind: Kind of events to stop watching, KEY_PRESSED_EVENT or 
  526.       KEY_RELEASED_EVENT.
  527.     @type kind: list
  528.     @raise KeyError: When the client isn't already registered for events
  529.     '''
  530.     # see if we already have an observer for this client
  531.     ob = self.clients[client]
  532.     if mask is None:
  533.       # None means all modifier combinations
  534.       mask = utils.allModifiers()
  535.     # register for new keystrokes on the observer
  536.     ob.unregister(self.dev, key_set, mask, kind)
  537.  
  538.   def generateKeyboardEvent(self, keycode, keysym, kind):
  539.     '''
  540.     Generates a keyboard event. One of the keycode or the keysym parameters
  541.     should be specified and the other should be None. The kind parameter is 
  542.     required and should be one of the KEY_PRESS, KEY_RELEASE, KEY_PRESSRELEASE,
  543.     KEY_SYM, or KEY_STRING.
  544.     
  545.     @param keycode: Hardware keycode or None
  546.     @type keycode: integer
  547.     @param keysym: Symbolic key string or None
  548.     @type keysym: string
  549.     @param kind: Kind of event to synthesize
  550.     @type kind: integer
  551.     '''
  552.     if keysym is None:
  553.       self.dev.generateKeyboardEvent(keycode, '', kind)
  554.     else:
  555.       self.dev.generateKeyboardEvent(None, keysym, kind)
  556.   
  557.   def generateMouseEvent(self, x, y, name):
  558.     '''
  559.     Generates a mouse event at the given absolute x and y coordinate. The kind
  560.     of event generated is specified by the name. For example, MOUSE_B1P 
  561.     (button 1 press), MOUSE_REL (relative motion), MOUSE_B3D (butten 3 
  562.     double-click).
  563.     
  564.     @param x: Horizontal coordinate, usually left-hand oriented
  565.     @type x: integer
  566.     @param y: Vertical coordinate, usually left-hand oriented
  567.     @type y: integer
  568.     @param name: Name of the event to generate
  569.     @type name: string
  570.     '''
  571.     self.dev.generateMouseEvent(x, y, name)
  572.     
  573.   def handleDeviceEvent(self, event, ob):
  574.     '''
  575.     Dispatches L{event.DeviceEvent}s to registered clients. Clients are called
  576.     in the order they were registered for the given AT-SPI event. If any
  577.     client returns True, callbacks cease for the event for clients of this registry 
  578.     instance. Clients of other registry instances and clients in other processes may 
  579.     be affected depending on the values of synchronous and preemptive used when invoking
  580.     L{registerKeystrokeListener}. 
  581.     
  582.     @note: Asynchronous dispatch of device events is not supported.
  583.     
  584.     @param event: AT-SPI device event
  585.     @type event: L{event.DeviceEvent}
  586.     @param ob: Observer that received the event
  587.     @type ob: L{_DeviceObserver}
  588.  
  589.     @return: Should the event be consumed (True) or allowed to pass on to other
  590.       AT-SPI observers (False)?
  591.     @rtype: boolean
  592.     '''
  593.     try:
  594.       # try to get the client registered for this event type
  595.       client = self.clients[ob]
  596.     except KeyError:
  597.       # client may have unregistered recently, ignore event
  598.       return False
  599.     # make the call to the client
  600.     try:
  601.       return client(event) or event.consume
  602.     except Exception:
  603.       # print the exception, but don't let it stop notification
  604.       traceback.print_exc()
  605.  
  606.   def handleEvent(self, event):
  607.     '''    
  608.     Handles an AT-SPI event by either queuing it for later dispatch when the
  609.     L{Registry.async} flag is set, or dispatching it immediately.
  610.  
  611.     @param event: AT-SPI event
  612.     @type event: L{event.Event}
  613.     '''
  614.     if self.async:
  615.       # queue for now
  616.       self.queue.put_nowait(event)
  617.     else:
  618.       # dispatch immediately
  619.       self._dispatchEvent(event)
  620.  
  621.   def _dispatchEvent(self, event):
  622.     '''
  623.     Dispatches L{event.Event}s to registered clients. Clients are called in
  624.     the order they were registered for the given AT-SPI event. If any client
  625.     returns True, callbacks cease for the event for clients of this registry 
  626.     instance. Clients of other registry instances and clients in other processes 
  627.     are unaffected.
  628.  
  629.     @param event: AT-SPI event
  630.     @type event: L{event.Event}
  631.     '''
  632.     et = event.type
  633.     try:
  634.       # try to get the client registered for this event type
  635.       clients = self.clients[et.name]
  636.     except KeyError:
  637.       try:
  638.         # we may not have registered for the complete subtree of events
  639.         # if our tree does not list all of a certain type (e.g.
  640.         # object:state-changed:*); try again with klass and major only
  641.         if et.detail is not None:
  642.           # Strip the 'detail' field.
  643.           clients = self.clients['%s:%s:%s' % (et.klass, et.major, et.minor)]
  644.         elif et.minor is not None:
  645.           # The event could possibly be object:state-changed:*.
  646.           clients = self.clients['%s:%s' % (et.klass, et.major)]
  647.       except KeyError:
  648.         # client may have unregistered recently, ignore event
  649.         return
  650.     # make the call to each client
  651.     consume = False
  652.     for client in clients:
  653.       try:
  654.         consume = client(event) or False
  655.       except Exception:
  656.         # print the exception, but don't let it stop notification
  657.         traceback.print_exc()
  658.       if consume or event.consume:
  659.         # don't allow further processing if a client returns True
  660.         break
  661.  
  662.   def flushEvents(self):
  663.     '''
  664.     Flushes the event queue by destroying it and recreating it.
  665.     '''
  666.     self.queue = Queue.Queue()
  667.  
  668.   def pumpQueuedEvents(self, num=-1):
  669.     '''
  670.     Provides asynch processing of events in the queue by executeing them with 
  671.     _dispatchEvent() (as is done immediately when synch processing). 
  672.     This method would normally be called from a main loop or idle function.
  673.  
  674.     @param num: Number of events to pump. If number is negative it pumps
  675.     the entire queue. Default is -1.
  676.     @type num: integer
  677.     @return: True if queue is not empty after events were pumped.
  678.     @rtype: boolean
  679.     '''
  680.     if num < 0:
  681.       # Dequeue as many events as currently in the queue.
  682.       num = self.queue.qsize()
  683.     for i in xrange(num):
  684.       try:
  685.         # get next waiting event
  686.         event = self.queue.get_nowait()
  687.       except Queue.Empty:
  688.         break
  689.       self._dispatchEvent(event)
  690.  
  691.     return not self.queue.empty()
  692.  
  693.   def _registerClients(self, client, name):
  694.     '''
  695.     Internal method that recursively associates a client with AT-SPI event 
  696.     names. Allows a client to incompletely specify an event name in order to 
  697.     register for subevents without specifying their full names manually.
  698.     
  699.     @param client: Client callback to receive event notifications
  700.     @type client: callable
  701.     @param name: Partial or full event name
  702.     @type name: string
  703.     '''
  704.     try:
  705.       # look for an event name in our event tree dictionary
  706.       events = constants.EVENT_TREE[name]
  707.     except KeyError:
  708.       # if the event name doesn't exist, it's a leaf event meaning there are
  709.       # no subtypes for that event
  710.       # add this client to the list of clients already in the dictionary 
  711.       # using the event name as the key; if there are no clients yet for this 
  712.       # event, insert an empty list into the dictionary before appending 
  713.       # the client
  714.       et = event.EventType(name)
  715.       clients = self.clients.setdefault(et.name, [])
  716.       try:
  717.         # if this succeeds, this client is already registered for the given
  718.         # event type, so ignore the request
  719.         clients.index(client)
  720.       except ValueError:
  721.         # else register the client
  722.         clients.append(client)
  723.         self._registerObserver(name)
  724.     else:
  725.         # if the event name does exist in the tree, there are subevents for
  726.         # this event; loop through them calling this method again to get to
  727.         # the leaf events
  728.         for e in events:
  729.           self._registerClients(client, e)
  730.       
  731.   def _unregisterClients(self, client, name):
  732.     '''
  733.     Internal method that recursively unassociates a client with AT-SPI event 
  734.     names. Allows a client to incompletely specify an event name in order to 
  735.     unregister for subevents without specifying their full names manually.
  736.     
  737.     @param client: Client callback to receive event notifications
  738.     @type client: callable
  739.     @param name: Partial or full event name
  740.     @type name: string
  741.     '''
  742.     missed = False
  743.     try:
  744.       # look for an event name in our event tree dictionary
  745.       events = constants.EVENT_TREE[name]
  746.     except KeyError:
  747.       try:
  748.         # if the event name doesn't exist, it's a leaf event meaning there are
  749.         # no subtypes for that event
  750.         # get the list of registered clients and try to remove the one provided
  751.         et = event.EventType(name)
  752.         clients = self.clients[et.name]
  753.         clients.remove(client)
  754.         self._unregisterObserver(name)
  755.       except (ValueError, KeyError):
  756.         # ignore any exceptions indicating the client is not registered
  757.         missed = True
  758.       return missed
  759.     # if the event name does exist in the tree, there are subevents for this 
  760.     # event; loop through them calling this method again to get to the leaf
  761.     # events
  762.     for e in events:
  763.       missed |= self._unregisterClients(client, e)
  764.     return missed
  765.   
  766.   def _registerObserver(self, name):
  767.     '''    
  768.     Creates a new L{_Observer} to watch for events of the given type or
  769.     returns the existing observer if one is already registered. One
  770.     L{_Observer} is created for each leaf in the L{constants.EVENT_TREE} or
  771.     any event name not found in the tree.
  772.    
  773.     @param name: Raw name of the event to observe
  774.     @type name: string
  775.     @return: L{_Observer} object that is monitoring the event
  776.     @rtype: L{_Observer}
  777.     '''
  778.     et = event.EventType(name)
  779.     try:
  780.       # see if an observer already exists for this event
  781.       ob = self.observers[et.name]
  782.     except KeyError:
  783.       # build a new observer if one does not exist
  784.       ob = _EventObserver(self)
  785.       # we have to register for the raw name because it may be different from
  786.       # the parsed name determined by EventType (e.g. trailing ':' might be 
  787.       # missing)
  788.       ob.register(self.reg, name)
  789.       self.observers[et.name] = ob
  790.     # increase our client ref count so we know someone new is watching for the 
  791.     # event
  792.     ob.clientRef()
  793.     return ob
  794.     
  795.   def _unregisterObserver(self, name):
  796.     '''    
  797.     Destroys an existing L{_Observer} for the given event type only if no
  798.     clients are registered for the events it is monitoring.
  799.     
  800.     @param name: Name of the event to observe
  801.     @type name: string
  802.     @raise KeyError: When an observer for the given event is not regist
  803.     '''
  804.     et = event.EventType(name)
  805.     # see if an observer already exists for this event
  806.     ob = self.observers[et.name]
  807.     ob.clientUnref()
  808.     if ob.getClientRefCount() == 0:
  809.       ob.unregister(self.reg, name)
  810.       del self.observers[et.name]
  811.